home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 002 / xword223.arc / XWORD.DOC next >
Text File  |  1986-04-27  |  13KB  |  271 lines
  1.                 X W O R D    D O C U M E N T A T I O N
  2.  
  3.  
  4.  
  5.  
  6.                             By Ronald Gans
  7.  
  8.                        350 West 55th Street #2-E
  9.  
  10.                        New York, New York  10019
  11.  
  12.  
  13.         (See the end of this file for registration information)
  14.  
  15.  
  16.  
  17.  
  18.  
  19.                              INTRODUCTION                        Page 1
  20.  
  21.                What You Should Have and What Is Required
  22.  
  23. There should be two files ARC'd together: XWORD.EXE and XWORD.DOC.  The
  24. only file that is essential to XWORD's operation is XWORD.EXE.  XWORD
  25. should work OK on any IBM PC (IBM PC-XT, IBM PC-AT, or close compatible,
  26. such as the COMPAQ or AT&T 6300).  XWORD.EXE requires about 80K bytes of
  27. memory and will only work with DOS 2.xx or above.  XWORD.EXE senses
  28. whether the monitor is monochrome or color, but in either case writes
  29. directly to the screen in the normal video mode.  This file, XWORD.DOC,
  30. should clarify some points of XWORD's operation.  See the end of this
  31. file for information about registration and copyright.
  32.  
  33. XWORD is a general file format transformer; that is, it converts files
  34. from one format to another.  Selections are made from two menus, "FORMAT
  35. CONVERTERS" and "LOGICAL AND BIT OPTIONS."
  36.  
  37. I have made some arbitrary decisions regarding what XWORD does to files.
  38. Sometimes it is not possible, or not possible without great difficulty,
  39. to preserve print options between different word processing formats.  In
  40. some of these cases, I have elected to eliminate them and let the user
  41. re-input them anew.  For those word processors which require a line
  42. length embedded in the files, I have chosen one arbitrarily, based on my
  43. own experience.
  44.  
  45. XWORD appends a 1AH to the ends of files under certain options.  Those
  46. options that convert files to ASCII format all append a 1AH to the file.
  47. This is not required for MS/PC-DOS, but it necessary in CP/M, to which
  48. ASCII files can be ported.
  49.  
  50.                         NON-MS-DOS ORIGIN FILES
  51.  
  52. A growing number of people are converting files from non-MS-DOS format
  53. to MS-DOS format.  Some of these files come from Apple or from dedicated
  54. wordprocessors like the Wang or CPT.  Even when these files are
  55. converted into ASCII, frequently the conversion is not like that in the
  56. MS-DOS environment in that the carriage return-line feed sequence is not
  57. the same.  Usually, instead of a CRLF, there is just a CR.  Currently,
  58. the ASCII to WordPerfect conversion of XWORD will handle either the CR
  59. or CRLF format (you don't have to know which one you have).  However, be
  60. careful that when the file was converted in ASCII, other formatting
  61. characters were not included which would make no sense (or have a
  62. different meaning) in the MS-DOS format.  For instance, the soft hyphen
  63. in CPT format is, I believe, the same as the ">" character in MS-DOS
  64. ASCII.  You will have to weed out these characters in your file.
  65.  
  66.  
  67.                  WILDCARDS, DRIVES, and SUBDIRECTORIES
  68.  
  69. XWORD supports wildcards (* and ?) in the source file name.  When
  70. wildcards are used, XWORD will ask you to supply a target path or drive
  71. different from that of the source files.  If a drive is specified, it
  72. must have the ":" after the drive letter.  If a path is specified, it
  73. must terminate with the subdirectory delimiter.  For most users, this is
  74. the backwards slash "\" but it can be other characters.  Even though
  75. XWORD should not overwrite source files, the user is STRONGLY ADVISED TO
  76. MAKE ALL CONVERSIONS ON COPIES OF FILES ONLY, NEVER ON THE ORIGINALS.
  77. Also NOTE THAT IF WILDCARDS ARE USED, FILES WHICH HAVE IDENTICAL NAMES
  78. TO THE SOURCE FILES (BUT ARE ON DIFFERENT DIRECTORIES) WILL BE
  79. OVERWRITTEN.
  80.  
  81.  
  82.  
  83.                                                                  Page 2
  84.  
  85.                                MENU ONE
  86.  
  87.                             REDUCING SPACES
  88.  
  89. Use only with ASCII or WordStar-compatible files.  DO NOT USE WITH
  90. MULTIMATE FILES OR WITH WORDSTAR 2000 FILES.  You will have to reboot if
  91. you try to load a file processed with the P option into Multimate or
  92. WordStar 2000.
  93.  
  94.                  WORDSTAR, WORDSTAR 2000, AND SIDEKICK
  95.  
  96. No special precautions need be taken regarding these files.  Both
  97. WordStar and WordStar 2000 will allow any kind of file name.  There is
  98. still a problem with tab handling (by XWORD), but the rest of the
  99. options of the two should be OK.  XWORD will support WordStar 2000's
  100. JUSTIFY.FRM, RAGGED.FRM, MEMO.FRM, and NORMAL.FRM.  It will not support
  101. the NOFORM.FRM.  This format is identical to ASCII.  Thus, if converting
  102. a file produced with WordStar 2000 and NOFORM.FRM, select ASCII as the
  103. source file format.
  104.  
  105. Sidekick is compatible with WordStar, BUT, the tabs of files written in
  106. WordStar's non-document mode show up as capital "I"s in Sidekick.  XWORD
  107. expands expands these tabs so they will appear properly.
  108.  
  109. If your file in WordStar2000 looks funny when XWORD is through with it,
  110. place the cursor at the beginning of the paragraph and press any letter
  111. (you will have to erase the letter you input).  This will cause
  112. WordStar2000 to reformat the paragraph.
  113.  
  114.  
  115.                                MULTIMATE
  116.  
  117. XWORD supports conversion into and out of MultiMate.  When converting
  118. from WordStar, be careful of indents.  Make sure that indents begin
  119. after a hard return or ^PM (equivalent to 0DH).  MultiMate requires all
  120. document files have the extension .DOC; XWORD appends this extension to
  121. MultiMate-target files.  You will notice that the converted Multimate
  122. file will often have more indents than it should.  This is due to the
  123. algorithm I used; a future version of XWORD will solve this problem.  I
  124. have used XWORD to convert files longer than 70K to MultiMate with no
  125. problems.  Converting into MultiMate with wildcards is the only instance
  126. in which wildcard use does not result in the original files being
  127. overwritten, unless they, too, have a .DOC extension.  When converting
  128. OUT of MultiMate, it is strongly advised that you repaginate your
  129. document before converting.  This is because MultiMate does not
  130. necessarily store the different "pages" in the same order they appear on
  131. the screen.  Page 12, for instance, may not necessarily be after Page
  132. 11.  (This will have no effect on using the file in MultiMate.)  This
  133. may occur if a file is very heavily edited.  Repagination helps reduce
  134. this problem.  (But, in any case, when you convert out of MultiMate its
  135. best to check and see that the file is all there and in the right order.
  136. If it is not, there will be a large chunk out of order, not just a word
  137. or two.)
  138.  
  139.                                                                   Page 3
  140.  
  141.                             XYWRITE II PLUS
  142.  
  143. No special precautions need be taken here, as XyWrite II is very friendly.
  144. (XWORD has been tested on Version 1.00.)
  145.  
  146.  
  147.                               WORDPERFECT
  148.  
  149. No special precautions are needed regarding conversion to or from
  150. WordPerfect. If you want to convert from MultiMate to WordPerfect, you
  151. might be better served by using WordPerfect's own conversion program.
  152.  
  153.  
  154.  
  155.                                MENU TWO
  156.  
  157. The options on this menu are for bit and byte manipulation.  Some of them can
  158. be used for a quick and dirty type of cryptography.  Three of the options
  159. require the user to input a value in hexadecimal format (digits 0-9 and
  160. letters A-F, which represent our common notion of 10, 11, 12, to 15); they
  161. are: AND, OR, XOR.  Another one, NOT, requires no other input from the user
  162. than the source and target file names.  ROL and ROR require the user supply a
  163. number between 1 and 7, inclusive.
  164.  
  165. The action of NOT, ROL and ROR are fully reversable.  That is, if NOT
  166. FileA produces FileB, and NOT FileB produces FileC, then FileC is
  167. identical to FileA.  ROR (ROtate through Right) and ROL (ROtate through
  168. Left) circulate the eight bits that compose each byte.  ROR 1 time
  169. shifts the bits in each bit right once; the rightmost bit is moved to
  170. the leftmost position (this information is merely for the elucidation of
  171. the user; the user does not have to understand the action of these
  172. options in order to use them).  ROL 1 acts in the same way, but to the
  173. left.  ROR 2 is the same as ROR 1 and then ROR 1 again.  If FileA is
  174. processed with ROR 3, say, producing FileB, and FileB is processed using
  175. ROL 3, producing FileC, then FileC is identical to FileA.  You can use a
  176. sequence of these options to scramble a file pretty well (but remember
  177. to record your sequence and go through it in reverse to unscramble it).
  178. That is, if your sequence was:
  179.  
  180.                      ROR 4, NOT, ROL 3, NOT, ROL 2
  181.  
  182.                     then to undo this, you must go:
  183.  
  184.                      ROR 2, NOT, ROR 3, NOT, ROL 4
  185.  
  186.  
  187.                                                                   Page 4
  188.                                 REPLACE
  189.  
  190. The last option on this menu, Replace, is different from the others.
  191. Replace allows the user to replace any text (ASCII) or hexadecimal
  192. string (a string is a sequence of bytes) by any other text or
  193. hexadecimal string.  The two strings do not have to both be ASCII or
  194. hex.  Additionally, the user can elect to save these strings and reuse
  195. them (especially useful if they were complicated to figure out).  The
  196. user will be prompted for a source file and then a target file; then,
  197. whether the string is to be entered in ASCII, hex, or from a previously
  198. saved file.  If the user enters a string in ASCII or hex, XWORD will ask
  199. if the user wants to save the string.  This sequence is repeated for the
  200. replacement (new) string.  Each string can be 30 bytes (characters)
  201. long.  When entering hex, note that each hex digit must be composed of
  202. two numerals (including letters).  Thus, the string more commonly
  203. written as 0DH,0AH,27H,64H,0FFH, would be enterd as 0D0A2764FF.
  204.  
  205. Remember that if you Replace a commonly occurring byte in a file with a long
  206. string, then your target file could become up to 30 times as large as the
  207. original file.
  208.  
  209. If you make an error during hex entry, hit the backspace key, and you will be
  210. reset to the beginning of hex entry.  Generally in XWORD, hitting the space
  211. bar, return, or end key lets you escape from one level of the program to
  212. another, and, except when files are actually being converted, control-C
  213. always works.
  214.  
  215.  
  216.                   OWNERSHIP, COPYRIGHTS, DISCLAIMERS
  217.  
  218. XWORD is the property of Ronald Gans; XWORD is unpublished and
  219. copyrighted.  XWORD may not be sold for profit by anyone.  If you
  220. purchased XWORD for more than the price of a disk, shipping, and
  221. handling, you got taken and should notify me of that fact, along with
  222. the name of the person or corporation from whom you purchased XWORD.
  223. XWORD.ARC, XWORD.EXE and XWORD.DOC may be freely copied and
  224. distributed, BUT ONLY AS LONG AS THEY ARE NOT ALTERED IN ANY WAY BY
  225. REVERSE PROGRAMMING OR EDITING; IF XWORD.EXE IS DISTRIBUTED IT MUST BE
  226. ACCOMPANIED BY XWORD.DOC.  None of these programs may be altered in any
  227. way by anyone.  No warranty is made or implied about the functioning of
  228. XWORD on any given system or computer configuration.  Ronald Gans is not
  229. responsible for any damage which may result from the using of XWORD on
  230. any computer.  Having said that, I will also state that I have tested
  231. XWORD on a variety of computer configurations (all IBM PC compatible)
  232. and found XWORD to run without damage to these systesm.  If you wish an
  233. alternate version of XWORD, please let me know.  Please direct all
  234. correspondence to:
  235.  
  236.                               RONALD GANS
  237.                          350 WEST 55TH STREET
  238.                        NEW YORK, NEW YORK 10019
  239.            CompuServe No. 74216,264 Telephone (212) 957-8361
  240.  
  241.                                                                   Page 5
  242.  
  243.  
  244.                              REGISTRATION
  245.  
  246. "I" option from Menu One of XWORD.EXE will print out an invoice on your
  247. printer (assuming you have a printer and it is connected to your
  248. computer).  If you wish to register your copy of XWORD, please fill out
  249. and mail the invoice form back to me at the above address along with
  250. $20.00 (N.Y.S. residents please add 8 1/4% sales tax for $21.65).  If
  251. you register, you are entitled to free upgrades for one year (there have
  252. been many revisions of XWORD since it was first released and I am
  253. continually working on it).  Additionally, if you wish to continue
  254. receiving upgrades after one year, an additional year will cost only
  255. $8.00.  Planned enhancements for XWORD include, of course, more word
  256. processing formats (VolksWriter, DCA, among others), greater depth to
  257. the formats currently supported, along with a greatly enhanced replace
  258. function allowing for "intelligent" replacement.
  259.  
  260.  
  261. WordStar and WordStar 2000 are registerd trademarks of MicroPro
  262. International Corporation.  MultiMate is a registered trademark of
  263. MultiMate International.  XyWrite II Plus is a registered trademark of
  264. XyQuest Inc.  Sidekick is a registered trademark of Borland
  265. International.  WordPerfect is a registered trademark of Satellite
  266. Software.  IBM PC, IBM PC-XT, IBM PC-AT are registered trademarks of
  267. International Business Machines, Inc.  AT&T 6300 is a registered
  268. trademark of American Telephone & Telegraph Company.  COMPAQ is a
  269. registered trademark of COMPAQ Computer Corporation.
  270.  
  271.